/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT3DCORE_QTHREADPOOLER_H
#define QT3DCORE_QTHREADPOOLER_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/QFuture>
#include <QtCore/QFutureInterface>
#include <QtCore/QObject>
#include <QtCore/QSharedPointer>
#include <QtCore/QThreadPool>

#include <Qt3DCore/private/dependencyhandler_p.h>
#include <Qt3DCore/private/qaspectjob_p.h>
#include <Qt3DCore/private/task_p.h>

#if QT_CONFIG(qt3d_profile_jobs)
#include <QtCore/QElapsedTimer>
#endif

QT_BEGIN_NAMESPACE

namespace Qt3DCore {

class QT3DCORE_PRIVATE_EXPORT QThreadPooler : public QObject
{
    Q_OBJECT

public:
    explicit QThreadPooler(QObject *parent = 0);
    ~QThreadPooler();

    QFuture<void> mapDependables(QVector<RunnableInterface *> &taskQueue);
    void taskFinished(RunnableInterface *task);
    QFuture<void> future();

    void setDependencyHandler(DependencyHandler *handler);

    int maxThreadCount() const;
#if QT_CONFIG(qt3d_profile_jobs)
    static QElapsedTimer m_jobsStatTimer;

    // Aspects + Job threads
    static void addJobLogStatsEntry(JobRunStats &stats);
    static void writeFrameJobLogStats();

    // Submission thread
    static void addSubmissionLogStatsEntry(JobRunStats &stats);

#endif

private:
    void enqueueTasks(const QVector<RunnableInterface *> &tasks);
    void acquire(int add);
    void release();
    int currentCount() const;

private:
    QFutureInterface<void> *m_futureInterface;
    QMutex m_mutex;
    DependencyHandler *m_dependencyHandler;
    QAtomicInt m_taskCount;
    QThreadPool m_threadPool;
};

} // namespace Qt3DCore

QT_END_NAMESPACE

#endif // QT3DCORE_QTHREADPOOLER_H
